docs: added summary section to contributing docs #573
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ijemmy
suggested changes
Feb 23, 2022
Contributor
ijemmy
left a comment
ijemmy
left a comment
There was a problem hiding this comment.
Not sure about the 2nd proposed change. May be too long?
But I do feel that we shouldn't use "TL;DR;" here. It is like telling them that it is ok to not read.
Co-authored-by: ijemmy <ijemmy@users.noreply.github.com>
Co-authored-by: ijemmy <ijemmy@users.noreply.github.com>
dreamorosi
changed the title
Contributor
Author
I like both your proposals better, thanks for the suggestions. Updated also the title of the PR. |
ijemmy
previously approved these changes
Feb 23, 2022
saragerion
reviewed
Feb 23, 2022
Contributor
saragerion
left a comment
saragerion
left a comment
There was a problem hiding this comment.
Added a minor suggestion :) thanksss
Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>
saragerion
approved these changes
Feb 23, 2022
ijemmy
approved these changes
Feb 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
Following some confusion from community contributors and maintainers alike this PR adds a terse TL;DR; (aka too long; didn't read) section at the top of the
CONTRIBUTING.mddocument to allow new contributors more easily get started.How to verify this change
Check changes in the Markdown file, preview below:
Related issues, RFCs
N/A
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.